Skip to main content

使用代码模式优化您的 API 调用

使用代码模式优化您的 API 调用

在 Zapier Platform UI 中,当您构建身份验证、触发器和操作时,会使用表单模式来创建集成中的每个组件。但是,如果需要对 API 调用进行更多自定义,可以切换到代码模式。

您可以使用代码模式来:

  • 将 API 响应转换为 JSON 格式

  • 将用户身份验证详细信息和输入表单数据添加到 API 调用中

  • 使用 'z' 对象库自定义您的 API 调用

  • 优化错误响应处理

​代码模式入门

要使用代码模式,Zapier 建议用户具备 JavaScript 基础知识,并了解如何进行 HTTP 请求

代码模式可在 API 请求设置中启用:

  • 对于身份验证,代码模式位于“配置测试请求和连接标签”设置中。请注意,对于 OAuth v2,代码模式位于“OAuth v2 端点配置”设置中。

  • 对于触发器和操作,代码模式位于“API 配置”设置中。

使用代码模式优化您的 API 调用

在代码模式中进行的更改不会自动保存。添加完所需的代码后,请点击“保存并继续”。

​代码模式的功能

​使用 z 对象自定义您的 API 调用

您可以编写 JavaScript 代码,以 Zapier 的默认代码为基础,或自行编写自定义代码。利用 z 对象访问 Zapier 特定功能,例如使用 z.console 写入控制台日志、z.JSON 解析 JSON,以及 z.errors 处理错误。请参阅 Zapier 的 CLI Z 对象文档 以了解更多信息。

​添加用户身份验证详细信息和输入表单数据

您可以使用 Zapier 的数据包访问身份验证数据、用户输入表单数据以及请求数据。请参阅 Zapier 数据包 以了解更多信息。

​导入库

您可以使用 z.require 从 Node 的标准库中导入模块,例如 z.require('querystring')z.require('crypto')。Zapier 强烈建议在 Platform UI 中保持代码简洁。构建和测试复杂代码更适合使用 Platform CLI。

Platform UI 中不支持 NPM 模块。如需添加额外库,请将项目导出到 Platform CLI,并使用 npm 进行管理。

​性能考虑

每个触发器和操作均有 30 秒的时间限制。为确保 Zap 正常运行,请让您的自定义代码尽可能轻量且高效。如果代码运行时间超过 30 秒,将导致超时,用户 Zap 会出错。我们无法保证所有导入的库都在运行环境中受支持。

以下是改善自定义代码性能的具体建议:

  • 使用高效的算法和数据结构。

  • 避免不必要的循环和递归。

  • 针对特定任务优化代码。

  • 避免使用对触发器或操作非必需的导入库。

​在表单模式和代码模式之间切换

切换到代码模式时,Zapier 会使用您的代码执行 API 调用。之前的表单模式设置不会被删除,这是因为表单模式和代码模式无法同时使用。

如果切换回表单模式,请点击“切换到表单模式”。您的先前表单模式设置将恢复,Zapier 会保留您在代码模式中输入的代码,以便后续使用。

​代码模式资源

以下是使用代码模式时有帮助的资源:

HTTP 请求选项

HTTP 响应对象

HTTP 请求

动态下拉菜单

返回类型

数据包对象

环境变量

占位符 vs 模板字面量

错误处理

错误响应处理

Schema 文档

14.x

13.x

12.x

需要帮助?告诉我们您的问题,我们会将您连接到合适的资源或支持团队。